Skip to main content
Version: Next

Get Challenges & Activities API

This API will get the all the Goals and Challenges & Activities data for the AOK

Get Goals Categories

  • Request Type : GET
  • End Point URL : /v1/getGoalCategory
  • Authorization : basic_auth

Parameters : NA

  • Sample URL : http://site_url/v1/getGoalCategory
  • Response Success Code : 200 OK
  • Sample Response
[
{
"goalCategoryId": 38,
"goalCategoryTitle": "Foodie",
"goalCategoryImage": "",
"goalCategoryDescription": "<p>foodie des</p>"
},
{
"goalCategoryId": 37,
"goalCategoryTitle": "Sports",
"goalCategoryImage": "http://dev-cms.navida-cloud.plus.aok.de/sites/default/files/AOK_Signet_Gruen_RGB_Small%202.svg",
"goalCategoryDescription": "<p>Demo Description</p>"
}
]

Get Goals & Challenges

  • Request Type : GET
  • End Point URL : /v1/getGoals
  • Authorization : basic_auth

Parameters : NA

ParameterDescription
aokid*AOK id is the AOK specefic unique id. It will filter the content and get the AOK specefic data.
categoryResponse can be filter using Goal Category
goalIdGet goal by goal id

Note :'*' Parameters are required

  • Sample URL : http://site_url/v1/getGoals?aokid=aokbw
  • Response Success Code : 200 OK
  • Sample Response
[
{
"goalId": 190,
"goalUUID": "",
"isActive": true,
"startDate": "15:30 24-06-2024",
"stopDate": "15:30 25-06-2024",
"goalCategoryId": 38,
"goalCategoryTitle": "Foodie",
"goalTitle": "Weniger Zucker ist süß",
"goalIcon": "http://dev-cms.navida-cloud.plus.aok.de/sites/default/files/events.png",
"goalImage": "http://dev-cms.navida-cloud.plus.aok.de/sites/default/files/Healthgoal1.jpg",
"goalShortDescription": "<p>Lerne was Zucker mit Deinem Körper macht und wie man auch ohne Zucker leckere Gerichte zubereiten kann.</p>\n",
"goalDescription": "<p>Lerne was Zucker mit Deinem Körper macht und wie man auch ohne Zucker leckere Gerichte zubereiten kann.</p><p><br>&nbsp;</p><p>Und das über 20 Tage und jeden Tag ein bisschen weniger Zucker.</p>",
"healthGoalSlogan": "",
"goalInfoSource": "",
"pillLeftImage": "http://dev-cms.navida-cloud.plus.aok.de/sites/default/files/giftIcon.png",
"pillRightImage": "http://dev-cms.navida-cloud.plus.aok.de/sites/default/files/pill_right_image.png",
"goalNumberOfDays": 25,
"goalPoints": 0,
"faqLink": "",
"tags": "",
"level": "",
"challenges": [
{
"challengeId": 107,
"challengeUUID": "",
"isActive": true,
"isHealthGadgetSupported": false,
"challengeTitle": "Plogging-Challenge",
"challengeIcon": "http://localhost:8081/navida-pro-be-cms/web/navida-pro-be-cms/web/sites/default/files/Challenges_Sport/2x_header_challenge_plogging.jpg",
"challengeImage": "http://localhost:8081/navida-pro-be-cms/web/navida-pro-be-cms/web/sites/default/files/Challenges_Sport/2x_header_challenge_plogging.jpg",
"challengeShortDescription": "Du favorisierst eher entspanntes Laufen und möchtest gleichzeitig der Umwelt etwas Gutes tun? Beim \"Plogging\" wird die Laufrunde zum Müllsammeln genutzt.",
"challengeDescription": "",
"challengeInfoSource": "",
"challengeNumberOfDays": 10,
"durationIndicator": "",
"challengeTime": 30,
"tags": "",
"level": "medium",
"minTimeNeeded": "",
"maxTimeNeeded": "",
"isKomootSupported": false,
"komootMinLength": 1000,
"komootMaxLength": 1500,
"komootMaxDistance": 2000,
"komootSportText": "Hike",
"challengeBenefits": [
{
"challengeBenefitId": 1377,
"challengeBenefitTitle": "Was wirst Du erreichen?",
"challengeBenefitDetails": [
{
"challengeBenefitDetailId": 1374,
"challengeBenefitIcon": "",
"challengeBenefitDetail": "Durch die Aktivität an der frischen Luft wird Dein Herz-Kreislaufsystem gestärkt."
},
{
"challengeBenefitDetailId": 1375,
"challengeBenefitIcon": "",
"challengeBenefitDetail": "Deine Fettverbrennung wird angekurbelt."
},
{
"challengeBenefitDetailId": 1376,
"challengeBenefitIcon": "",
"challengeBenefitDetail": "Du tust der Umwelt etwas Gutes – das sorgt nebenbei für die Ausschüttung von Glückshormonen."
}
]
}
],
"challengePrecautionInactive": [],
"challengePrecautionActive": [],
"challengeActivities": [ {
"activityId": 680,
"activityUUID": "",
"activityTitle": "Lektion 1 - Starte Dein Zuckertagebuch",
"activityDuration": "",
"activityUrl": "",
"activityDescription": "<p>Lerne Dich und Dein Naschverhalten besser kennen. Das Naschtagebuch hilft Dir dabei!</p>",
"fromMET": "",
"toMET": "",
"level": "",
"preCautionInfoCard": [],
"activityImageUrls": [],
"activityVideoUrls": [],
"SubActivities": []
}
]
}
],
"assessment": [
{
"id": 676,
"title": "",
"image": "",
"shortDescription": "",
"optionDescription": "",
"link": "",
"moreInformation": [
{
"title": "",
"icon": "",
"description": "",
"linkText": ""
}
],
"options": [
{
"optionId": "674",
"optionTitle": "",
"optionScore": ""
}
]
}
],
"scoringScale": [
{
"low": [
{
"min": "",
"max": ""
}
],
"medium": [
{
"min": "",
"max": ""
}
],
"high": [
{
"min": "",
"max": ""
}
]
}
],
"infoCardList": [],
"goalPrecautionCard": []
}
]